[JENKINS-70044] Add telemetry for activation of optional permissions #7342

dwnusbaum · 2022-11-08T19:53:32Z

Note that we would like to backport this change to the LTS. https://www.jenkins.io/download/lts/#backporting-process does not list telemetry explicitly, but otherwise we will have to set activation dates far into the future and then wait for this to be picked up by the next LTS baseline. I recall @daniel-beck mentioning that new telemetry collectors have been backported in the past, but I could not find any discussion of this from a very quick search on the developer mailing list.

Testing done

I tested this PR by replacing Telemetry.ENDPOINT with a link to https://webhook.site, then I called ExtensionList.lookupSingleton(jenkins.telemetry.impl.OptionalPermissions.class).run() from the Jenkins script console and verified that the request showed up with the expected content. I then installed credentials and manage-permission from the Plugin Manager, reran the script, and verified that the credentials-related permissions were included in the payload and that hudson.model.Hudson.Manage was now marked as being enabled.

Sample payload

{
    "components": {
        "bouncycastle-api": "2.26",
        "credentials": "1189.vf61b_a_5e2f62e",
        "instance-identity": "116.vf8f487400980",
        "javax-activation-api": "1.2.0-5",
        "javax-mail-api": "1.6.2-8",
        "jenkins-core": "2.378-SNAPSHOT",
        "manage-permission": "1.0.1",
        "mina-sshd-api-common": "2.9.1-44.v476733c11f82",
        "mina-sshd-api-core": "2.9.1-44.v476733c11f82",
        "sshd": "3.249.v2dc2ea_416e33",
        "structs": "324.va_f5d6774f3a_d"
    },
    "permissions": {
        "com.cloudbees.plugins.credentials.CredentialsProvider.UseItem": false,
        "com.cloudbees.plugins.credentials.CredentialsProvider.UseOwn": false,
        "hudson.model.Computer.ExtendedRead": false,
        "hudson.model.Hudson.Manage": true,
        "hudson.model.Hudson.SystemRead": false,
        "hudson.model.Item.ExtendedRead": false,
        "hudson.model.Item.WipeOut": false,
        "hudson.model.Run.Artifacts": false
    }
}

I did not add any automated tests. TelemetryTest already covers the overall behavior of the Telemetry extension point. I can add a test that checks the output of OptionalPermissions.createContent if reviewers think that would be useful.

Proposed changelog entries

Add telemetry for activation of permissions that are not enabled by default.

Proposed upgrade guidelines

N/A

Submitter checklist

The Jira issue, if it exists, is well-described.
The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see examples).
- Fill in the Proposed upgrade guidelines section only if there are breaking changes or changes that may require extra steps from users during upgrade.
There is automated testing or an explanation as to why this change has no tests.
New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
New or substantially changed JavaScript is not defined inline and does not call eval to ease future introduction of Content Security Policy (CSP) directives (see documentation).
For dependency updates, there are links to external changelogs and, if possible, full differentials.
For new APIs and extension points, there is a link to at least one consumer.

Desired reviewers

@mention

Maintainer checklist

Before the changes are marked as ready-for-merge:

There are at least two (2) approvals for the pull request and no outstanding requests for change.
Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
Proper changelog labels are set so that the changelog can be generated automatically.
If the change needs additional upgrade steps from users, the upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the pull request title (see example).
If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).

dwnusbaum · 2022-11-08T19:56:41Z

core/src/main/java/jenkins/telemetry/impl/OptionalPermissions.java

+    @Override
+    public LocalDate getStart() {
+        return LocalDate.of(2022, 11, 1);
+    }
+
+    @Override
+    public LocalDate getEnd() {
+        return LocalDate.of(2023, 3, 1);
+    }


I am not sure what dates make the most sense. I set the start to 2022-11-01 to facilitate testing. Depending on whether we can backport this and what the LTS schedule is like, maybe 2023-02-01 could be a more conservative end date, but my concern is that many users will refrain from updating during the holiday season and so December and January data will be sparse and perhaps non-representative of the overall userbase.

…ry collector

core/src/main/resources/jenkins/telemetry/impl/OptionalPermissions/description.jelly

daniel-beck · 2022-11-08T22:41:22Z

I recall @daniel-beck mentioning that new telemetry collectors have been backported in the past, but I could not find any discussion of this from a very quick search on the developer mailing list.

Some past examples I was involved with, basically everything has been backported into LTS:

JENKINS-53768 backported initial telemetry infrastructure into 2.138.2 with @Restricted (discussed and approved in the 2018-09-26 project meeting).
JENKINS-54029 backported Stapler dispatch telemetry into 2.138.3.
JENKINS-57167 backported re-activation of Stapler telemetry into 2.164.3.
JENKINS-67229 backported agent-to-controller file path access logging telemetry into 2.319.1.

I don't know whether there's been an "official" discussion on the topic of backporting eligibility of telemetry. In the initial JEP request for comments thread I wrote,

It's also difficult to say right now how we'd handle LTS releases -- would collectors be eligible for backports? (I say yes, as optional extension points written such that they mostly silently fail.)

but there were no further responses on the topic (at least no active rejections of this).

To me, the backporting requirement basically follows logically from the idea of keeping the collection period short, ideally just a few months to collect less data. Anything less than around 4-6 months or so given the would not result in a broad user base to collect from, making data less meaningful, while specifying very long durations to cover both LTS and weekly will result in the unnecessary collection of data from weekly users. We could specify dates several months into the future, but, aside from causing delays in the projects these collectors would support, that may also cause bugs in the implementation (and we've had those) to only be discovered months after the code has been added to all recent releases, both weekly and LTS, removing our ability to quickly react to regressions reported in weekly releases.

And many past implementations collected data for just this short of a period, producing useful data during that time:

security-system-properties (the JEP-214 reference impl) collected for 3 months,
AcceptLanguages for 3 months,
Stapler (1): ~3.7 months (the re-activation added ~3 months),
agent-to-controller file path for just over 3 months once it was merged.

None of these would have been able to cover data from across the user base (i.e., including LTS) without a backport.

daniel-beck

Looks good and seems to contain all of the disabled-by-default permissions.

Suggested docs change to make this accurate (we don't actually collect system properties).

core/src/main/resources/jenkins/telemetry/impl/OptionalPermissions/description.jelly

Wadeck

👍

NotMyFault

Fine with me to backport this into 2.375.1 👍🏻

Co-authored-by: Daniel Beck <[email protected]>

NotMyFault · 2022-11-10T09:32:08Z

/label ready-for-merge

This PR is now ready for merge. We will merge it after ~24 hours if there is no negative feedback.
Please see the merge process documentation for more information about the merge process.
Thanks!

…enkinsci#7342) * [JENKINS-70044] Add telemetry for activation of optional permissions * [JENKINS-70044] Add description.jelly for OptionalPermissions telemetry collector * [JENKINS-70044] Improve phrasing in description.jelly Co-authored-by: Daniel Beck <[email protected]> Co-authored-by: Daniel Beck <[email protected]> (cherry picked from commit 8b58686)

[JENKINS-70044] Add telemetry for activation of optional permissions

c08bf02

dwnusbaum requested review from daniel-beck, Wadeck, yaroslavafenkin and Kevin-CB November 8, 2022 19:53

dwnusbaum commented Nov 8, 2022

View reviewed changes

[JENKINS-70044] Add description.jelly for OptionalPermissions telemet…

1386a2b

…ry collector

dwnusbaum commented Nov 8, 2022

View reviewed changes

core/src/main/resources/jenkins/telemetry/impl/OptionalPermissions/description.jelly Outdated Show resolved Hide resolved

daniel-beck approved these changes Nov 9, 2022

View reviewed changes

core/src/main/resources/jenkins/telemetry/impl/OptionalPermissions/description.jelly Outdated Show resolved Hide resolved

NotMyFault added the rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted label Nov 9, 2022

Wadeck approved these changes Nov 9, 2022

View reviewed changes

NotMyFault approved these changes Nov 9, 2022

View reviewed changes

yaroslavafenkin approved these changes Nov 9, 2022

View reviewed changes

[JENKINS-70044] Improve phrasing in description.jelly

f46823b

Co-authored-by: Daniel Beck <[email protected]>

comment-ops-bot bot added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Nov 10, 2022

NotMyFault merged commit 8b58686 into jenkinsci:master Nov 11, 2022

dwnusbaum deleted the optional-permissions branch November 11, 2022 16:21

daniel-beck mentioned this pull request Oct 11, 2023

Add telemetry for Jenkins uptime #8596

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[JENKINS-70044] Add telemetry for activation of optional permissions #7342

[JENKINS-70044] Add telemetry for activation of optional permissions #7342

dwnusbaum commented Nov 8, 2022 •

edited by MarkEWaite

Loading

dwnusbaum Nov 8, 2022 •

edited

Loading

daniel-beck commented Nov 8, 2022 •

edited

Loading

daniel-beck left a comment

Wadeck left a comment

NotMyFault left a comment

NotMyFault commented Nov 10, 2022

[JENKINS-70044] Add telemetry for activation of optional permissions #7342

[JENKINS-70044] Add telemetry for activation of optional permissions #7342

Conversation

dwnusbaum commented Nov 8, 2022 • edited by MarkEWaite Loading

Testing done

Proposed changelog entries

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

dwnusbaum Nov 8, 2022 • edited Loading

Choose a reason for hiding this comment

daniel-beck commented Nov 8, 2022 • edited Loading

daniel-beck left a comment

Choose a reason for hiding this comment

Wadeck left a comment

Choose a reason for hiding this comment

NotMyFault left a comment

Choose a reason for hiding this comment

NotMyFault commented Nov 10, 2022

dwnusbaum commented Nov 8, 2022 •

edited by MarkEWaite

Loading

dwnusbaum Nov 8, 2022 •

edited

Loading

daniel-beck commented Nov 8, 2022 •

edited

Loading